feat: add qmd skill for markdown knowledge base search#72
Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
Adds the qmd skill to enable local hybrid search over markdown knowledge bases, along with documentation for CLI usage and manual MCP setup.
Changes:
- Added
tobi/qmdtoSKILLS.txtfor external skill installation - Introduced
skills/qmd/SKILL.mddocumenting usage via CLI and MCP tools - Added
skills/qmd/references/mcp-setup.mdwith manual MCP configuration guidance
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| skills/qmd/references/mcp-setup.md | Adds manual MCP configuration instructions and tool reference |
| skills/qmd/SKILL.md | Adds skill definition + CLI/MCP usage documentation |
| SKILLS.txt | Registers tobi/qmd as an installable external skill |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Command | Use When | Speed | | ||
| |---------|----------|-------| | ||
| | `qmd search` | Exact keyword matches needed | Fast | | ||
| | `qmd vsearch` | Keywords aren't working, need conceptual matches | Medium | | ||
| | `qmd query` | Best results needed, speed not critical | Slower | |
There was a problem hiding this comment.
These tables use || at the start of each row, which is not standard Markdown table syntax and may not render correctly. Use a single leading pipe (|) per row (e.g., | Command | Use When | Speed |) so the tables render consistently across Markdown viewers.
| | Score | Meaning | Action | | ||
| |-------|---------|--------| | ||
| | 0.8 - 1.0 | Highly relevant | Show to user | | ||
| | 0.5 - 0.8 | Moderately relevant | Include if few results | | ||
| | 0.2 - 0.5 | Somewhat relevant | Only if user wants more | | ||
| | 0.0 - 0.2 | Low relevance | Usually skip | |
There was a problem hiding this comment.
These tables use || at the start of each row, which is not standard Markdown table syntax and may not render correctly. Use a single leading pipe (|) per row (e.g., | Command | Use When | Speed |) so the tables render consistently across Markdown viewers.
| | MCP Tool | Equivalent CLI | Purpose | | ||
| |----------|---------------|---------| | ||
| | `qmd_search` | `qmd search` | Fast BM25 keyword search | | ||
| | `qmd_vector_search` | `qmd vsearch` | Semantic vector search | | ||
| | `qmd_deep_search` | `qmd query` | Deep search with expansion and reranking | | ||
| | `qmd_get` | `qmd get` | Retrieve document by path or docid | | ||
| | `qmd_multi_get` | `qmd multi-get` | Retrieve multiple documents | | ||
| | `qmd_status` | `qmd status` | Index health and collection info | |
There was a problem hiding this comment.
These tables use || at the start of each row, which is not standard Markdown table syntax and may not render correctly. Use a single leading pipe (|) per row (e.g., | Command | Use When | Speed |) so the tables render consistently across Markdown viewers.
| | Scenario | Recommendation | | ||
| |----------|---------------| | ||
| | MCP configured | Use `qmd_*` tools directly | | ||
| | No MCP | Use Bash with `qmd` commands | | ||
| | Complex pipelines | Bash may be more flexible | | ||
| | Simple lookups | MCP tools are cleaner | |
There was a problem hiding this comment.
The 'Choosing Between CLI and MCP' table also uses || at the start of each row, which is likely to render incorrectly in many Markdown parsers. Switch to standard Markdown table formatting using a single leading |.
| compatibility: Requires qmd CLI or MCP server. Install via `bun install -g https://github.com/tobi/qmd`. | ||
| metadata: | ||
| author: tobi | ||
| version: "1.1.1" |
There was a problem hiding this comment.
The skill metadata declares version 1.1.1, but the install command pulls from the repository default branch, which can drift from this documented version. Consider pinning the install command to a tag/commit (matching 1.1.1) or adjust the metadata/version wording so users don’t end up with a different version than the docs imply.
| version: "1.1.1" | |
| version: "unstable (tracks repository default branch)" |
| Manual MCP configuration for use without the qmd plugin. | ||
|
|
||
| > **Note**: If using the qmd plugin, MCP configuration is included automatically. This is only needed for manual setup. |
There was a problem hiding this comment.
This repository introduces qmd as a skill, but this doc refers to a 'plugin'. To reduce confusion for users reading within this repo, consider replacing 'plugin' with 'skill' (or clarifying the relationship if both terms are intentional).
| Manual MCP configuration for use without the qmd plugin. | |
| > **Note**: If using the qmd plugin, MCP configuration is included automatically. This is only needed for manual setup. | |
| Manual MCP configuration for use without the qmd skill. | |
| > **Note**: If using the qmd skill, MCP configuration is included automatically. This is only needed for manual setup. |
Summary
Test plan
make ruler-preparecopies skill to.ruler/skills/make syncdistributes to all agent skill directories🤖 Generated with Claude Code
Summary by cubic
Adds the qmd skill for local hybrid search across markdown notes and docs (BM25 + vectors + LLM reranking). Provides CLI and MCP tool support so agents can search personal knowledge bases.
Written for commit d14ea49. Summary will update on new commits.